Create Online PSTN Gateway

The Create Online PSTN Gateway request creates a new Online PSTN Gateway.

HTTP Method

POST

URI

Copy

{{baseUrl}}/api/v3/customer/CustomerGuid/addNewOnlinePstnGateway

Request Parameters

Parameter

Type

Description

CustomerGuid

string ($uuid)

umpCustomerGuid created in the Live Platform customer tenant SQL database :

■

Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.

■

Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created.

Request Body

Parameter

Type

Description

Trunk Model

string

The trunk type used in multi‑tenant Direct Routing hosting scenarios where the SBC (Session Border Controller) is managed by a carrier/hoster and services many customer tenants.

■

Derived Trunk: Customer user calls are routed directly through the Service Provider SBC generated-trunk Hosted Direct Routing infrastructure

■

AzureAdDomainOnly: Domain that is registered in Azure AD only and not enabled for SIP Voice. Calls for this SIP connection are routed through the Derived Trunk.

FQDN

string

Sub domain of the customer SIP Connection in the following format <SIPConnectionName>.<SBCDomainName>

Where <SIPConnectionName> is the Live Platform SIP entity for the customer site used to connect to the SBC and <SBCDomainName> is the FQDN of the SBC device attached to the SIP Connection.

licensePlanId

integer

webhooks

list array

List array including the following:

■

dnsConfirmation

■

done

■

error

dnsConfirmation

string

done

string

error

string

scriptParameters refers to:

CustomVar.Variable<VariableSequenceNumber>

dictionary

where <VariableSequenceNumber> is the sequence in database that the variable is defined in the 'Customer variables' column for the script properties (see Customer Variables).

For example, when the following IP-PBX variables are defined in the database in the order: IPPBX-ProxyAddress, IPPBX-ProxyAddress-SIPPort, SIP-HostName then Custom variables should be defined as follows:

■

CustomVar.Variable1: <: IPPBX-ProxyAddress>

■

CustomVar.Variable2: < IPPBX-ProxyAddress-SIPPort>

■

CustomVar.Variable3: <SIP-HostName>

Custom variables can be defined to update specific parameters on the SBC device. These variables must be predefined in the UMP-365 database (see Customer Variables). Also verify that the custom variables notation has been added to the script (see parameter 'sbcOnboardingScript' above) that you are applying to the request.

There are three fields displayed in the schema additionalProp1-3, however there is no limitation for the number of variables that can be added.

additionalProp1

string

Custom Script variable argument. For example IP-Network.

additionalProp2

string

Custom Script argument. For example, IP-SubnetBits.

additionalProp3

string

Custom Script argument. For example, Trusted-IP-Network.

Example Response

The initial response displays the Task Id.

Parameter	Type	Description
Task Id	string	The queued task Id that is generated for this action. You must run the Task request to retrieve the status of the action. See Task Status. Note that the wup string in the prefix is unique for this endpoint.

Copy

{
    "taskId": "wup_c14a0a55-fcc5-4598-b405-c978e7da1af4"
}

HTTP Responses

■

202 Accepted

Attribute	Type	Description

■

404 Not Found

The table below shows the full list of fields returned in this response. The actual fields returned may differ according to the request.

Parameter	Type	Description
type	string	Error type
title	string	Email title
status	integer	StatusCodes.Status400BadRequest
detail	string	Additional error details.
instance	string	HttpContext.Request.Path
errorTicket	string	errId.ToString()
errorCode	string	Error code output in the request
traceId	string	HttpContext.TraceIdentifier
additionalProp1	string	TBD
additionalProp2	string	TBD
additionalProp3	string	TBD

■

500 Internal Server Error